<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<meta name="robots" content="noindex">

	<title>File controllers/api/Key.php</title>

	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
				<h3>Packages</h3>
			<ul>
				<li>
					<a href="package-CodeIgniter.html">
						CodeIgniter<span></span>
					</a>

						<ul>
				<li>
					<a href="package-CodeIgniter.Libraries.html">
						Libraries					</a>

						</li>
				<li>
					<a href="package-CodeIgniter.Rest.html">
						Rest					</a>

						</li>
							</ul></li>
				<li>
					<a href="package-None.html">
						None					</a>

						</li>
			</ul>
		</div>

		<hr>


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Example.html">Example</a></li>
				<li><a href="class-Format.html">Format</a></li>
				<li><a href="class-Key.html">Key</a></li>
				<li><a href="class-REST_Controller.html">REST_Controller</a></li>
				<li><a href="class-Rest_server.html">Rest_server</a></li>
				<li><a href="class-Welcome.html">Welcome</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="">
		<input type="hidden" name="ie" value="UTF-8">
		<input type="text" name="q" class="text" placeholder="Search">
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
<span>Package</span>			</li>
			<li>
<span>Class</span>			</li>
		</ul>
		<ul>
		</ul>
		<ul>
		</ul>
	</div>

<pre><code><span id="1" class="l"><a href="#1">  1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a href="#2">  2: </a>
</span><span id="3" class="l"><a href="#3">  3: </a><span class="php-keyword2">defined</span>(<span class="php-quote">'BASEPATH'</span>) <span class="php-keyword1">OR</span> <span class="php-keyword1">exit</span>(<span class="php-quote">'No direct script access allowed'</span>);
</span><span id="4" class="l"><a href="#4">  4: </a>
</span><span id="5" class="l"><a href="#5">  5: </a><span class="php-comment">// This can be removed if you use __autoload() in config.php OR use Modular Extensions</span>
</span><span id="6" class="l"><a href="#6">  6: </a><span class="php-keyword1">require</span> APPPATH . <span class="php-quote">'/libraries/REST_Controller.php'</span>;
</span><span id="7" class="l"><a href="#7">  7: </a>
</span><span id="8" class="l"><a href="#8">  8: </a><span class="php-comment">/**
</span></span><span id="9" class="l"><a href="#9">  9: </a><span class="php-comment"> * Keys Controller
</span></span><span id="10" class="l"><a href="#10"> 10: </a><span class="php-comment"> * This is a basic Key Management REST controller to make and delete keys
</span></span><span id="11" class="l"><a href="#11"> 11: </a><span class="php-comment"> *
</span></span><span id="12" class="l"><a href="#12"> 12: </a><span class="php-comment"> * @package         CodeIgniter
</span></span><span id="13" class="l"><a href="#13"> 13: </a><span class="php-comment"> * @subpackage      Rest Server
</span></span><span id="14" class="l"><a href="#14"> 14: </a><span class="php-comment"> * @category        Controller
</span></span><span id="15" class="l"><a href="#15"> 15: </a><span class="php-comment"> * @author          Phil Sturgeon, Chris Kacerguis
</span></span><span id="16" class="l"><a href="#16"> 16: </a><span class="php-comment"> * @license         MIT
</span></span><span id="17" class="l"><a href="#17"> 17: </a><span class="php-comment"> * @link            https://github.com/chriskacerguis/codeigniter-restserver
</span></span><span id="18" class="l"><a href="#18"> 18: </a><span class="php-comment"> */</span>
</span><span id="19" class="l"><a href="#19"> 19: </a><span class="php-keyword1">class</span> <span class="php-keyword2">Key</span> <span class="php-keyword1">extends</span> REST_Controller {
</span><span id="20" class="l"><a href="#20"> 20: </a>
</span><span id="21" class="l"><a href="#21"> 21: </a>    <span class="php-keyword1">protected</span> <span class="php-var">$methods</span> = [
</span><span id="22" class="l"><a href="#22"> 22: </a>            <span class="php-quote">'index_put'</span> =&gt; [<span class="php-quote">'level'</span> =&gt; <span class="php-num">10</span>, <span class="php-quote">'limit'</span> =&gt; <span class="php-num">10</span>],
</span><span id="23" class="l"><a href="#23"> 23: </a>            <span class="php-quote">'index_delete'</span> =&gt; [<span class="php-quote">'level'</span> =&gt; <span class="php-num">10</span>],
</span><span id="24" class="l"><a href="#24"> 24: </a>            <span class="php-quote">'level_post'</span> =&gt; [<span class="php-quote">'level'</span> =&gt; <span class="php-num">10</span>],
</span><span id="25" class="l"><a href="#25"> 25: </a>            <span class="php-quote">'regenerate_post'</span> =&gt; [<span class="php-quote">'level'</span> =&gt; <span class="php-num">10</span>],
</span><span id="26" class="l"><a href="#26"> 26: </a>        ];
</span><span id="27" class="l"><a href="#27"> 27: </a>
</span><span id="28" class="l"><a href="#28"> 28: </a>    <span class="php-comment">/**
</span></span><span id="29" class="l"><a href="#29"> 29: </a><span class="php-comment">     * Insert a key into the database
</span></span><span id="30" class="l"><a href="#30"> 30: </a><span class="php-comment">     *
</span></span><span id="31" class="l"><a href="#31"> 31: </a><span class="php-comment">     * @access public
</span></span><span id="32" class="l"><a href="#32"> 32: </a><span class="php-comment">     * @return void
</span></span><span id="33" class="l"><a href="#33"> 33: </a><span class="php-comment">     */</span>
</span><span id="34" class="l"><a href="#34"> 34: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> index_put()
</span><span id="35" class="l"><a href="#35"> 35: </a>    {
</span><span id="36" class="l"><a href="#36"> 36: </a>        <span class="php-comment">// Build a new key</span>
</span><span id="37" class="l"><a href="#37"> 37: </a>        <span class="php-var">$key</span> = <span class="php-var">$this</span>-&gt;_generate_key();
</span><span id="38" class="l"><a href="#38"> 38: </a>
</span><span id="39" class="l"><a href="#39"> 39: </a>        <span class="php-comment">// If no key level provided, provide a generic key</span>
</span><span id="40" class="l"><a href="#40"> 40: </a>        <span class="php-var">$level</span> = <span class="php-var">$this</span>-&gt;put(<span class="php-quote">'level'</span>) ? <span class="php-var">$this</span>-&gt;put(<span class="php-quote">'level'</span>) : <span class="php-num">1</span>;
</span><span id="41" class="l"><a href="#41"> 41: </a>        <span class="php-var">$ignore_limits</span> = <span class="php-keyword2">ctype_digit</span>(<span class="php-var">$this</span>-&gt;put(<span class="php-quote">'ignore_limits'</span>)) ? (int) <span class="php-var">$this</span>-&gt;put(<span class="php-quote">'ignore_limits'</span>) : <span class="php-num">1</span>;
</span><span id="42" class="l"><a href="#42"> 42: </a>
</span><span id="43" class="l"><a href="#43"> 43: </a>        <span class="php-comment">// Insert the new key</span>
</span><span id="44" class="l"><a href="#44"> 44: </a>        <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;_insert_key(<span class="php-var">$key</span>, [<span class="php-quote">'level'</span> =&gt; <span class="php-var">$level</span>, <span class="php-quote">'ignore_limits'</span> =&gt; <span class="php-var">$ignore_limits</span>]))
</span><span id="45" class="l"><a href="#45"> 45: </a>        {
</span><span id="46" class="l"><a href="#46"> 46: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="47" class="l"><a href="#47"> 47: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">TRUE</span>,
</span><span id="48" class="l"><a href="#48"> 48: </a>                <span class="php-quote">'key'</span> =&gt; <span class="php-var">$key</span>
</span><span id="49" class="l"><a href="#49"> 49: </a>            ], REST_Controller::HTTP_CREATED); <span class="php-comment">// CREATED (201) being the HTTP response code</span>
</span><span id="50" class="l"><a href="#50"> 50: </a>        }
</span><span id="51" class="l"><a href="#51"> 51: </a>        <span class="php-keyword1">else</span>
</span><span id="52" class="l"><a href="#52"> 52: </a>        {
</span><span id="53" class="l"><a href="#53"> 53: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="54" class="l"><a href="#54"> 54: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="55" class="l"><a href="#55"> 55: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Could not save the key'</span>
</span><span id="56" class="l"><a href="#56"> 56: </a>            ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); <span class="php-comment">// INTERNAL_SERVER_ERROR (500) being the HTTP response code</span>
</span><span id="57" class="l"><a href="#57"> 57: </a>        }
</span><span id="58" class="l"><a href="#58"> 58: </a>    }
</span><span id="59" class="l"><a href="#59"> 59: </a>
</span><span id="60" class="l"><a href="#60"> 60: </a>    <span class="php-comment">/**
</span></span><span id="61" class="l"><a href="#61"> 61: </a><span class="php-comment">     * Remove a key from the database to stop it working
</span></span><span id="62" class="l"><a href="#62"> 62: </a><span class="php-comment">     *
</span></span><span id="63" class="l"><a href="#63"> 63: </a><span class="php-comment">     * @access public
</span></span><span id="64" class="l"><a href="#64"> 64: </a><span class="php-comment">     * @return void
</span></span><span id="65" class="l"><a href="#65"> 65: </a><span class="php-comment">     */</span>
</span><span id="66" class="l"><a href="#66"> 66: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> index_delete()
</span><span id="67" class="l"><a href="#67"> 67: </a>    {
</span><span id="68" class="l"><a href="#68"> 68: </a>        <span class="php-var">$key</span> = <span class="php-var">$this</span>-&gt;<span class="php-keyword2">delete</span>(<span class="php-quote">'key'</span>);
</span><span id="69" class="l"><a href="#69"> 69: </a>
</span><span id="70" class="l"><a href="#70"> 70: </a>        <span class="php-comment">// Does this key exist?</span>
</span><span id="71" class="l"><a href="#71"> 71: </a>        <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;_key_exists(<span class="php-var">$key</span>))
</span><span id="72" class="l"><a href="#72"> 72: </a>        {
</span><span id="73" class="l"><a href="#73"> 73: </a>            <span class="php-comment">// It doesn't appear the key exists</span>
</span><span id="74" class="l"><a href="#74"> 74: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="75" class="l"><a href="#75"> 75: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="76" class="l"><a href="#76"> 76: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Invalid API key'</span>
</span><span id="77" class="l"><a href="#77"> 77: </a>            ], REST_Controller::HTTP_BAD_REQUEST); <span class="php-comment">// BAD_REQUEST (400) being the HTTP response code</span>
</span><span id="78" class="l"><a href="#78"> 78: </a>        }
</span><span id="79" class="l"><a href="#79"> 79: </a>
</span><span id="80" class="l"><a href="#80"> 80: </a>        <span class="php-comment">// Destroy it</span>
</span><span id="81" class="l"><a href="#81"> 81: </a>        <span class="php-var">$this</span>-&gt;_delete_key(<span class="php-var">$key</span>);
</span><span id="82" class="l"><a href="#82"> 82: </a>
</span><span id="83" class="l"><a href="#83"> 83: </a>        <span class="php-comment">// Respond that the key was destroyed</span>
</span><span id="84" class="l"><a href="#84"> 84: </a>        <span class="php-var">$this</span>-&gt;response([
</span><span id="85" class="l"><a href="#85"> 85: </a>            <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">TRUE</span>,
</span><span id="86" class="l"><a href="#86"> 86: </a>            <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'API key was deleted'</span>
</span><span id="87" class="l"><a href="#87"> 87: </a>            ], REST_Controller::HTTP_NO_CONTENT); <span class="php-comment">// NO_CONTENT (204) being the HTTP response code</span>
</span><span id="88" class="l"><a href="#88"> 88: </a>    }
</span><span id="89" class="l"><a href="#89"> 89: </a>
</span><span id="90" class="l"><a href="#90"> 90: </a>    <span class="php-comment">/**
</span></span><span id="91" class="l"><a href="#91"> 91: </a><span class="php-comment">     * Change the level
</span></span><span id="92" class="l"><a href="#92"> 92: </a><span class="php-comment">     *
</span></span><span id="93" class="l"><a href="#93"> 93: </a><span class="php-comment">     * @access public
</span></span><span id="94" class="l"><a href="#94"> 94: </a><span class="php-comment">     * @return void
</span></span><span id="95" class="l"><a href="#95"> 95: </a><span class="php-comment">     */</span>
</span><span id="96" class="l"><a href="#96"> 96: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> level_post()
</span><span id="97" class="l"><a href="#97"> 97: </a>    {
</span><span id="98" class="l"><a href="#98"> 98: </a>        <span class="php-var">$key</span> = <span class="php-var">$this</span>-&gt;post(<span class="php-quote">'key'</span>);
</span><span id="99" class="l"><a href="#99"> 99: </a>        <span class="php-var">$new_level</span> = <span class="php-var">$this</span>-&gt;post(<span class="php-quote">'level'</span>);
</span><span id="100" class="l"><a href="#100">100: </a>
</span><span id="101" class="l"><a href="#101">101: </a>        <span class="php-comment">// Does this key exist?</span>
</span><span id="102" class="l"><a href="#102">102: </a>        <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;_key_exists(<span class="php-var">$key</span>))
</span><span id="103" class="l"><a href="#103">103: </a>        {
</span><span id="104" class="l"><a href="#104">104: </a>            <span class="php-comment">// It doesn't appear the key exists</span>
</span><span id="105" class="l"><a href="#105">105: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="106" class="l"><a href="#106">106: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="107" class="l"><a href="#107">107: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Invalid API key'</span>
</span><span id="108" class="l"><a href="#108">108: </a>            ], REST_Controller::HTTP_BAD_REQUEST); <span class="php-comment">// BAD_REQUEST (400) being the HTTP response code</span>
</span><span id="109" class="l"><a href="#109">109: </a>        }
</span><span id="110" class="l"><a href="#110">110: </a>
</span><span id="111" class="l"><a href="#111">111: </a>        <span class="php-comment">// Update the key level</span>
</span><span id="112" class="l"><a href="#112">112: </a>        <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;_update_key(<span class="php-var">$key</span>, [<span class="php-quote">'level'</span> =&gt; <span class="php-var">$new_level</span>]))
</span><span id="113" class="l"><a href="#113">113: </a>        {
</span><span id="114" class="l"><a href="#114">114: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="115" class="l"><a href="#115">115: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">TRUE</span>,
</span><span id="116" class="l"><a href="#116">116: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'API key was updated'</span>
</span><span id="117" class="l"><a href="#117">117: </a>            ], REST_Controller::HTTP_OK); <span class="php-comment">// OK (200) being the HTTP response code</span>
</span><span id="118" class="l"><a href="#118">118: </a>        }
</span><span id="119" class="l"><a href="#119">119: </a>        <span class="php-keyword1">else</span>
</span><span id="120" class="l"><a href="#120">120: </a>        {
</span><span id="121" class="l"><a href="#121">121: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="122" class="l"><a href="#122">122: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="123" class="l"><a href="#123">123: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Could not update the key level'</span>
</span><span id="124" class="l"><a href="#124">124: </a>            ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); <span class="php-comment">// INTERNAL_SERVER_ERROR (500) being the HTTP response code</span>
</span><span id="125" class="l"><a href="#125">125: </a>        }
</span><span id="126" class="l"><a href="#126">126: </a>    }
</span><span id="127" class="l"><a href="#127">127: </a>
</span><span id="128" class="l"><a href="#128">128: </a>    <span class="php-comment">/**
</span></span><span id="129" class="l"><a href="#129">129: </a><span class="php-comment">     * Suspend a key
</span></span><span id="130" class="l"><a href="#130">130: </a><span class="php-comment">     *
</span></span><span id="131" class="l"><a href="#131">131: </a><span class="php-comment">     * @access public
</span></span><span id="132" class="l"><a href="#132">132: </a><span class="php-comment">     * @return void
</span></span><span id="133" class="l"><a href="#133">133: </a><span class="php-comment">     */</span>
</span><span id="134" class="l"><a href="#134">134: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> suspend_post()
</span><span id="135" class="l"><a href="#135">135: </a>    {
</span><span id="136" class="l"><a href="#136">136: </a>        <span class="php-var">$key</span> = <span class="php-var">$this</span>-&gt;post(<span class="php-quote">'key'</span>);
</span><span id="137" class="l"><a href="#137">137: </a>
</span><span id="138" class="l"><a href="#138">138: </a>        <span class="php-comment">// Does this key exist?</span>
</span><span id="139" class="l"><a href="#139">139: </a>        <span class="php-keyword1">if</span> (!<span class="php-var">$this</span>-&gt;_key_exists(<span class="php-var">$key</span>))
</span><span id="140" class="l"><a href="#140">140: </a>        {
</span><span id="141" class="l"><a href="#141">141: </a>            <span class="php-comment">// It doesn't appear the key exists</span>
</span><span id="142" class="l"><a href="#142">142: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="143" class="l"><a href="#143">143: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="144" class="l"><a href="#144">144: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Invalid API key'</span>
</span><span id="145" class="l"><a href="#145">145: </a>            ], REST_Controller::HTTP_BAD_REQUEST); <span class="php-comment">// BAD_REQUEST (400) being the HTTP response code</span>
</span><span id="146" class="l"><a href="#146">146: </a>        }
</span><span id="147" class="l"><a href="#147">147: </a>
</span><span id="148" class="l"><a href="#148">148: </a>        <span class="php-comment">// Update the key level</span>
</span><span id="149" class="l"><a href="#149">149: </a>        <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;_update_key(<span class="php-var">$key</span>, [<span class="php-quote">'level'</span> =&gt; <span class="php-num">0</span>]))
</span><span id="150" class="l"><a href="#150">150: </a>        {
</span><span id="151" class="l"><a href="#151">151: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="152" class="l"><a href="#152">152: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">TRUE</span>,
</span><span id="153" class="l"><a href="#153">153: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Key was suspended'</span>
</span><span id="154" class="l"><a href="#154">154: </a>            ], REST_Controller::HTTP_OK); <span class="php-comment">// OK (200) being the HTTP response code</span>
</span><span id="155" class="l"><a href="#155">155: </a>        }
</span><span id="156" class="l"><a href="#156">156: </a>        <span class="php-keyword1">else</span>
</span><span id="157" class="l"><a href="#157">157: </a>        {
</span><span id="158" class="l"><a href="#158">158: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="159" class="l"><a href="#159">159: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="160" class="l"><a href="#160">160: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Could not suspend the user'</span>
</span><span id="161" class="l"><a href="#161">161: </a>            ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); <span class="php-comment">// INTERNAL_SERVER_ERROR (500) being the HTTP response code</span>
</span><span id="162" class="l"><a href="#162">162: </a>        }
</span><span id="163" class="l"><a href="#163">163: </a>    }
</span><span id="164" class="l"><a href="#164">164: </a>
</span><span id="165" class="l"><a href="#165">165: </a>    <span class="php-comment">/**
</span></span><span id="166" class="l"><a href="#166">166: </a><span class="php-comment">     * Regenerate a key
</span></span><span id="167" class="l"><a href="#167">167: </a><span class="php-comment">     *
</span></span><span id="168" class="l"><a href="#168">168: </a><span class="php-comment">     * @access public
</span></span><span id="169" class="l"><a href="#169">169: </a><span class="php-comment">     * @return void
</span></span><span id="170" class="l"><a href="#170">170: </a><span class="php-comment">     */</span>
</span><span id="171" class="l"><a href="#171">171: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> regenerate_post()
</span><span id="172" class="l"><a href="#172">172: </a>    {
</span><span id="173" class="l"><a href="#173">173: </a>        <span class="php-var">$old_key</span> = <span class="php-var">$this</span>-&gt;post(<span class="php-quote">'key'</span>);
</span><span id="174" class="l"><a href="#174">174: </a>        <span class="php-var">$key_details</span> = <span class="php-var">$this</span>-&gt;_get_key(<span class="php-var">$old_key</span>);
</span><span id="175" class="l"><a href="#175">175: </a>
</span><span id="176" class="l"><a href="#176">176: </a>        <span class="php-comment">// Does this key exist?</span>
</span><span id="177" class="l"><a href="#177">177: </a>        <span class="php-keyword1">if</span> (!<span class="php-var">$key_details</span>)
</span><span id="178" class="l"><a href="#178">178: </a>        {
</span><span id="179" class="l"><a href="#179">179: </a>            <span class="php-comment">// It doesn't appear the key exists</span>
</span><span id="180" class="l"><a href="#180">180: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="181" class="l"><a href="#181">181: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="182" class="l"><a href="#182">182: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Invalid API key'</span>
</span><span id="183" class="l"><a href="#183">183: </a>            ], REST_Controller::HTTP_BAD_REQUEST); <span class="php-comment">// BAD_REQUEST (400) being the HTTP response code</span>
</span><span id="184" class="l"><a href="#184">184: </a>        }
</span><span id="185" class="l"><a href="#185">185: </a>
</span><span id="186" class="l"><a href="#186">186: </a>        <span class="php-comment">// Build a new key</span>
</span><span id="187" class="l"><a href="#187">187: </a>        <span class="php-var">$new_key</span> = <span class="php-var">$this</span>-&gt;_generate_key();
</span><span id="188" class="l"><a href="#188">188: </a>
</span><span id="189" class="l"><a href="#189">189: </a>        <span class="php-comment">// Insert the new key</span>
</span><span id="190" class="l"><a href="#190">190: </a>        <span class="php-keyword1">if</span> (<span class="php-var">$this</span>-&gt;_insert_key(<span class="php-var">$new_key</span>, [<span class="php-quote">'level'</span> =&gt; <span class="php-var">$key_details</span>-&gt;level, <span class="php-quote">'ignore_limits'</span> =&gt; <span class="php-var">$key_details</span>-&gt;ignore_limits]))
</span><span id="191" class="l"><a href="#191">191: </a>        {
</span><span id="192" class="l"><a href="#192">192: </a>            <span class="php-comment">// Suspend old key</span>
</span><span id="193" class="l"><a href="#193">193: </a>            <span class="php-var">$this</span>-&gt;_update_key(<span class="php-var">$old_key</span>, [<span class="php-quote">'level'</span> =&gt; <span class="php-num">0</span>]);
</span><span id="194" class="l"><a href="#194">194: </a>
</span><span id="195" class="l"><a href="#195">195: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="196" class="l"><a href="#196">196: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">TRUE</span>,
</span><span id="197" class="l"><a href="#197">197: </a>                <span class="php-quote">'key'</span> =&gt; <span class="php-var">$new_key</span>
</span><span id="198" class="l"><a href="#198">198: </a>            ], REST_Controller::HTTP_CREATED); <span class="php-comment">// CREATED (201) being the HTTP response code</span>
</span><span id="199" class="l"><a href="#199">199: </a>        }
</span><span id="200" class="l"><a href="#200">200: </a>        <span class="php-keyword1">else</span>
</span><span id="201" class="l"><a href="#201">201: </a>        {
</span><span id="202" class="l"><a href="#202">202: </a>            <span class="php-var">$this</span>-&gt;response([
</span><span id="203" class="l"><a href="#203">203: </a>                <span class="php-quote">'status'</span> =&gt; <span class="php-keyword1">FALSE</span>,
</span><span id="204" class="l"><a href="#204">204: </a>                <span class="php-quote">'message'</span> =&gt; <span class="php-quote">'Could not save the key'</span>
</span><span id="205" class="l"><a href="#205">205: </a>            ], REST_Controller::HTTP_INTERNAL_SERVER_ERROR); <span class="php-comment">// INTERNAL_SERVER_ERROR (500) being the HTTP response code</span>
</span><span id="206" class="l"><a href="#206">206: </a>        }
</span><span id="207" class="l"><a href="#207">207: </a>    }
</span><span id="208" class="l"><a href="#208">208: </a>
</span><span id="209" class="l"><a href="#209">209: </a>    <span class="php-comment">/* Helper Methods */</span>
</span><span id="210" class="l"><a href="#210">210: </a>
</span><span id="211" class="l"><a href="#211">211: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> _generate_key()
</span><span id="212" class="l"><a href="#212">212: </a>    {
</span><span id="213" class="l"><a href="#213">213: </a>        <span class="php-keyword1">do</span>
</span><span id="214" class="l"><a href="#214">214: </a>        {
</span><span id="215" class="l"><a href="#215">215: </a>            <span class="php-comment">// Generate a random salt</span>
</span><span id="216" class="l"><a href="#216">216: </a>            <span class="php-var">$salt</span> = <span class="php-var">$this</span>-&gt;security-&gt;get_random_bytes(<span class="php-num">64</span>);
</span><span id="217" class="l"><a href="#217">217: </a>
</span><span id="218" class="l"><a href="#218">218: </a>            <span class="php-comment">// If an error occurred, then fall back to the previous method</span>
</span><span id="219" class="l"><a href="#219">219: </a>            <span class="php-keyword1">if</span> (<span class="php-var">$salt</span> === <span class="php-keyword1">FALSE</span>)
</span><span id="220" class="l"><a href="#220">220: </a>            {
</span><span id="221" class="l"><a href="#221">221: </a>                <span class="php-var">$salt</span> = <span class="php-keyword2">hash</span>(<span class="php-quote">'sha256'</span>, <span class="php-keyword2">time</span>() . <span class="php-keyword2">mt_rand</span>());
</span><span id="222" class="l"><a href="#222">222: </a>            }
</span><span id="223" class="l"><a href="#223">223: </a>
</span><span id="224" class="l"><a href="#224">224: </a>            <span class="php-var">$new_key</span> = <span class="php-keyword2">substr</span>(<span class="php-var">$salt</span>, <span class="php-num">0</span>, config_item(<span class="php-quote">'rest_key_length'</span>));
</span><span id="225" class="l"><a href="#225">225: </a>        }
</span><span id="226" class="l"><a href="#226">226: </a>        <span class="php-keyword1">while</span> (<span class="php-var">$this</span>-&gt;_key_exists(<span class="php-var">$new_key</span>));
</span><span id="227" class="l"><a href="#227">227: </a>
</span><span id="228" class="l"><a href="#228">228: </a>        <span class="php-keyword1">return</span> <span class="php-var">$new_key</span>;
</span><span id="229" class="l"><a href="#229">229: </a>    }
</span><span id="230" class="l"><a href="#230">230: </a>
</span><span id="231" class="l"><a href="#231">231: </a>    <span class="php-comment">/* Private Data Methods */</span>
</span><span id="232" class="l"><a href="#232">232: </a>
</span><span id="233" class="l"><a href="#233">233: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> _get_key(<span class="php-var">$key</span>)
</span><span id="234" class="l"><a href="#234">234: </a>    {
</span><span id="235" class="l"><a href="#235">235: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db
</span><span id="236" class="l"><a href="#236">236: </a>            -&gt;where(config_item(<span class="php-quote">'rest_key_column'</span>), <span class="php-var">$key</span>)
</span><span id="237" class="l"><a href="#237">237: </a>            -&gt;get(config_item(<span class="php-quote">'rest_keys_table'</span>))
</span><span id="238" class="l"><a href="#238">238: </a>            -&gt;row();
</span><span id="239" class="l"><a href="#239">239: </a>    }
</span><span id="240" class="l"><a href="#240">240: </a>
</span><span id="241" class="l"><a href="#241">241: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> _key_exists(<span class="php-var">$key</span>)
</span><span id="242" class="l"><a href="#242">242: </a>    {
</span><span id="243" class="l"><a href="#243">243: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db
</span><span id="244" class="l"><a href="#244">244: </a>            -&gt;where(config_item(<span class="php-quote">'rest_key_column'</span>), <span class="php-var">$key</span>)
</span><span id="245" class="l"><a href="#245">245: </a>            -&gt;count_all_results(config_item(<span class="php-quote">'rest_keys_table'</span>)) &gt; <span class="php-num">0</span>;
</span><span id="246" class="l"><a href="#246">246: </a>    }
</span><span id="247" class="l"><a href="#247">247: </a>
</span><span id="248" class="l"><a href="#248">248: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> _insert_key(<span class="php-var">$key</span>, <span class="php-var">$data</span>)
</span><span id="249" class="l"><a href="#249">249: </a>    {
</span><span id="250" class="l"><a href="#250">250: </a>        <span class="php-var">$data</span>[config_item(<span class="php-quote">'rest_key_column'</span>)] = <span class="php-var">$key</span>;
</span><span id="251" class="l"><a href="#251">251: </a>        <span class="php-var">$data</span>[<span class="php-quote">'date_created'</span>] = <span class="php-keyword2">function_exists</span>(<span class="php-quote">'now'</span>) ? now() : <span class="php-keyword2">time</span>();
</span><span id="252" class="l"><a href="#252">252: </a>
</span><span id="253" class="l"><a href="#253">253: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db
</span><span id="254" class="l"><a href="#254">254: </a>            -&gt;set(<span class="php-var">$data</span>)
</span><span id="255" class="l"><a href="#255">255: </a>            -&gt;insert(config_item(<span class="php-quote">'rest_keys_table'</span>));
</span><span id="256" class="l"><a href="#256">256: </a>    }
</span><span id="257" class="l"><a href="#257">257: </a>
</span><span id="258" class="l"><a href="#258">258: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> _update_key(<span class="php-var">$key</span>, <span class="php-var">$data</span>)
</span><span id="259" class="l"><a href="#259">259: </a>    {
</span><span id="260" class="l"><a href="#260">260: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db
</span><span id="261" class="l"><a href="#261">261: </a>            -&gt;where(config_item(<span class="php-quote">'rest_key_column'</span>), <span class="php-var">$key</span>)
</span><span id="262" class="l"><a href="#262">262: </a>            -&gt;update(config_item(<span class="php-quote">'rest_keys_table'</span>), <span class="php-var">$data</span>);
</span><span id="263" class="l"><a href="#263">263: </a>    }
</span><span id="264" class="l"><a href="#264">264: </a>
</span><span id="265" class="l"><a href="#265">265: </a>    <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> _delete_key(<span class="php-var">$key</span>)
</span><span id="266" class="l"><a href="#266">266: </a>    {
</span><span id="267" class="l"><a href="#267">267: </a>        <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;db
</span><span id="268" class="l"><a href="#268">268: </a>            -&gt;where(config_item(<span class="php-quote">'rest_key_column'</span>), <span class="php-var">$key</span>)
</span><span id="269" class="l"><a href="#269">269: </a>            -&gt;<span class="php-keyword2">delete</span>(config_item(<span class="php-quote">'rest_keys_table'</span>));
</span><span id="270" class="l"><a href="#270">270: </a>    }
</span><span id="271" class="l"><a href="#271">271: </a>
</span><span id="272" class="l"><a href="#272">272: </a>}
</span><span id="273" class="l"><a href="#273">273: </a></span></code></pre>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</div>
<script src="resources/combined.js?9b19127dc1973cca467c5196ef1ff03e486369ac"></script>
<script src="elementlist.js?af98f5e580ce1d5af01f3e613339e1bf53dfaa8f"></script>
</body>
</html>
